@edge-runtime/vm

What is @edge-runtime/vm?

@edge-runtime/vm is a Node.js package that provides a runtime environment for executing JavaScript code in a secure and isolated context. It is particularly useful for edge computing scenarios where you need to run code close to the data source with minimal latency.

What are @edge-runtime/vm's main functionalities?

Execute JavaScript Code

This feature allows you to execute arbitrary JavaScript code within a secure and isolated virtual machine context.

const { EdgeVM } = require('@edge-runtime/vm');
const vm = new EdgeVM();
const result = vm.run('2 + 2');
console.log(result); // 4

Sandboxed Environment

You can create a sandboxed environment with predefined global variables, ensuring that the executed code does not have access to the outer scope.

const { EdgeVM } = require('@edge-runtime/vm');
const vm = new EdgeVM({ sandbox: { foo: 'bar' } });
const result = vm.run('foo');
console.log(result); // 'bar'

Timeouts and Resource Limits

This feature allows you to set execution timeouts and resource limits to prevent infinite loops and excessive resource consumption.

const { EdgeVM } = require('@edge-runtime/vm');
const vm = new EdgeVM({ timeout: 1000 });
try {
  vm.run('while(true) {}');
} catch (e) {
  console.log(e.message); // 'Script execution timed out.'
}

Other packages similar to @edge-runtime/vm

vm2

vm2 is a popular Node.js package that provides a sandboxed environment for executing JavaScript code. It offers similar functionalities to @edge-runtime/vm, such as running code in an isolated context and setting resource limits. However, vm2 is more mature and widely used in the community.

isolated-vm

isolated-vm is another Node.js package designed for running JavaScript code in isolation. It provides a high level of security and performance, making it suitable for scenarios where you need to run untrusted code. Compared to @edge-runtime/vm, isolated-vm offers more advanced features like shared memory and asynchronous execution.

README

@edge-runtime/vm: Low level bindings for creating Web Standard contexts.

See @edge-runtime/vm section in our website for more information.

Install

Using npm:

npm install @edge-runtime/vm --save

or using yarn:

yarn add @edge-runtime/vm --dev

or using pnpm:

pnpm install @edge-runtime/vm --save

License

@edge-runtime/vm © Vercel, released under the MPLv2 License.
Authored and maintained by Vercel with help from contributors.

vercel.com · GitHub Vercel · Twitter @vercel